@ckeditor/ckeditor5-engine

What is @ckeditor/ckeditor5-engine?

@ckeditor/ckeditor5-engine is a core package of CKEditor 5, a modern JavaScript rich text editor. This package provides the engine that powers the editor, including the data model, editing view, and rendering process. It is highly modular and extensible, allowing developers to create custom editing experiences.

What are @ckeditor/ckeditor5-engine's main functionalities?

Creating a Document

This feature allows you to create a new document instance, which is the core of the editing engine. The document holds the data model and manages the editing operations.

const { Document } = require('@ckeditor/ckeditor5-engine');
const doc = new Document();
console.log(doc);

Adding a Root Element

This feature allows you to add a root element to the document. The root element is the top-level container for the document's content.

const { Document } = require('@ckeditor/ckeditor5-engine');
const doc = new Document();
const root = doc.createRoot();
console.log(root);

Inserting Text

This feature allows you to insert text into the document. The Writer class is used to perform editing operations on the document.

const { Document, Writer } = require('@ckeditor/ckeditor5-engine');
const doc = new Document();
const root = doc.createRoot();
const writer = new Writer();
writer.insertText('Hello, world!', root);
console.log(root);

Listening to Changes

This feature allows you to listen to changes in the document. The document emits events whenever its content is modified, enabling you to react to these changes.

const { Document } = require('@ckeditor/ckeditor5-engine');
const doc = new Document();
doc.on('change', (event, batch) => {
  console.log('Document changed:', batch);
});

Other packages similar to @ckeditor/ckeditor5-engine

prosemirror

ProseMirror is a toolkit for building rich-text editors on the web. It provides a similar data model and editing capabilities as @ckeditor/ckeditor5-engine but is more low-level, offering greater flexibility at the cost of requiring more setup and configuration.

slate

Slate is another framework for building rich text editors. It offers a more React-friendly API compared to @ckeditor/ckeditor5-engine and is highly customizable. However, it may require more effort to implement complex features.

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It provides a simpler API compared to @ckeditor/ckeditor5-engine and is easier to get started with, but it may not offer the same level of customization and control.

README

CKEditor 5 editing engine

The CKEditor 5 editing engine implements a flexible MVC-based architecture for creating rich text editing features.

Documentation

See the @ckeditor/ckeditor5-engine package page in CKEditor 5 documentation.

License

Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.